Skip to content

MkTreeView

Show source on GitHub

Node to display tree structures.

Description

Currently supports directories and Node subclasses (including MkNodes).

Example: Different styles

Jinja

{{ "mknodes/manual" | MkTreeView }}

Python

MkTreeView('mknodes/manual')

manual/
├── 📄__init__.py
├── 📁__pycache__/
│   ├── 📄__init__.cpython-311.pyc
│   ├── 📄a_quick_tour.cpython-311.pyc
│   ├── 📄dev_section.cpython-311.pyc
│   ├── 📄get_started_section.cpython-311.pyc
│   ├── 📄navs_section.cpython-311.pyc
│   ├── 📄nodes_section.cpython-311.pyc
│   ├── 📄page_section.cpython-311.pyc
│   ├── 📄root.cpython-311.pyc
│   ├── 📄routing.cpython-311.pyc
│   ╰── 📄templating_section.cpython-311.pyc
├── 📄a_quick_tour.py
├── 📄dev_section.py
├── 📄get_started_section.py
├── 📄github_index.py
├── 📄navs_section.py
├── 📄nodes_section.py
├── 📄page_section.py
├── 📄root.py
├── 📄routing.py
╰── 📄templating_section.py

```` 
manual/
├── 📄__init__.py
├── 📁__pycache__/
│   ├── 📄__init__.cpython-311.pyc
│   ├── 📄a_quick_tour.cpython-311.pyc
│   ├── 📄dev_section.cpython-311.pyc
│   ├── 📄get_started_section.cpython-311.pyc
│   ├── 📄navs_section.cpython-311.pyc
│   ├── 📄nodes_section.cpython-311.pyc
│   ├── 📄page_section.cpython-311.pyc
│   ├── 📄root.cpython-311.pyc
│   ├── 📄routing.cpython-311.pyc
│   ╰── 📄templating_section.cpython-311.pyc
├── 📄a_quick_tour.py
├── 📄dev_section.py
├── 📄get_started_section.py
├── 📄github_index.py
├── 📄navs_section.py
├── 📄nodes_section.py
├── 📄page_section.py
├── 📄root.py
├── 📄routing.py
╰── 📄templating_section.py
````

<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>manual/
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>├── 📄__init__.py
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>├── 📁__pycache__/
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>│   ├── 📄__init__.cpython-311.pyc
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>│   ├── 📄a_quick_tour.cpython-311.pyc
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>│   ├── 📄dev_section.cpython-311.pyc
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>│   ├── 📄get_started_section.cpython-311.pyc
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>│   ├── 📄navs_section.cpython-311.pyc
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>│   ├── 📄nodes_section.cpython-311.pyc
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>│   ├── 📄page_section.cpython-311.pyc
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>│   ├── 📄root.cpython-311.pyc
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>│   ├── 📄routing.cpython-311.pyc
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>│   ╰── 📄templating_section.cpython-311.pyc
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>├── 📄a_quick_tour.py
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>├── 📄dev_section.py
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>├── 📄get_started_section.py
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>├── 📄github_index.py
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>├── 📄navs_section.py
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>├── 📄nodes_section.py
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>├── 📄page_section.py
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>├── 📄root.py
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>├── 📄routing.py
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>╰── 📄templating_section.py
</span></code></pre></div>

Example: Style 'ansi'

Jinja

{{ "mknodes/manual" | MkTreeView(style="ansi") }}

Python

MkTreeView('mknodes/manual', style='ansi')

manual/
|-- 📄__init__.py
|-- 📁__pycache__/
|   |-- 📄__init__.cpython-311.pyc
|   |-- 📄a_quick_tour.cpython-311.pyc
|   |-- 📄dev_section.cpython-311.pyc
|   |-- 📄get_started_section.cpython-311.pyc
|   |-- 📄navs_section.cpython-311.pyc
|   |-- 📄nodes_section.cpython-311.pyc
|   |-- 📄page_section.cpython-311.pyc
|   |-- 📄root.cpython-311.pyc
|   |-- 📄routing.cpython-311.pyc
|   `-- 📄templating_section.cpython-311.pyc
|-- 📄a_quick_tour.py
|-- 📄dev_section.py
|-- 📄get_started_section.py
|-- 📄github_index.py
|-- 📄navs_section.py
|-- 📄nodes_section.py
|-- 📄page_section.py
|-- 📄root.py
|-- 📄routing.py
`-- 📄templating_section.py

```` 
manual/
|-- 📄__init__.py
|-- 📁__pycache__/
|   |-- 📄__init__.cpython-311.pyc
|   |-- 📄a_quick_tour.cpython-311.pyc
|   |-- 📄dev_section.cpython-311.pyc
|   |-- 📄get_started_section.cpython-311.pyc
|   |-- 📄navs_section.cpython-311.pyc
|   |-- 📄nodes_section.cpython-311.pyc
|   |-- 📄page_section.cpython-311.pyc
|   |-- 📄root.cpython-311.pyc
|   |-- 📄routing.cpython-311.pyc
|   `-- 📄templating_section.cpython-311.pyc
|-- 📄a_quick_tour.py
|-- 📄dev_section.py
|-- 📄get_started_section.py
|-- 📄github_index.py
|-- 📄navs_section.py
|-- 📄nodes_section.py
|-- 📄page_section.py
|-- 📄root.py
|-- 📄routing.py
`-- 📄templating_section.py
````

<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>manual/
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>|-- 📄__init__.py
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>|-- 📁__pycache__/
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>|   |-- 📄__init__.cpython-311.pyc
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>|   |-- 📄a_quick_tour.cpython-311.pyc
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>|   |-- 📄dev_section.cpython-311.pyc
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>|   |-- 📄get_started_section.cpython-311.pyc
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>|   |-- 📄navs_section.cpython-311.pyc
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>|   |-- 📄nodes_section.cpython-311.pyc
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>|   |-- 📄page_section.cpython-311.pyc
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>|   |-- 📄root.cpython-311.pyc
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>|   |-- 📄routing.cpython-311.pyc
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>|   `-- 📄templating_section.cpython-311.pyc
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>|-- 📄a_quick_tour.py
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>|-- 📄dev_section.py
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>|-- 📄get_started_section.py
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>|-- 📄github_index.py
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>|-- 📄navs_section.py
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>|-- 📄nodes_section.py
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>|-- 📄page_section.py
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>|-- 📄root.py
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>|-- 📄routing.py
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>`-- 📄templating_section.py
</span></code></pre></div>

Example: Style 'ascii'

Jinja

{{ "mknodes/manual" | MkTreeView(style="ascii") }}

Python

MkTreeView('mknodes/manual', style='ascii')

manual/
|-- 📄__init__.py
|-- 📁__pycache__/
|   |-- 📄__init__.cpython-311.pyc
|   |-- 📄a_quick_tour.cpython-311.pyc
|   |-- 📄dev_section.cpython-311.pyc
|   |-- 📄get_started_section.cpython-311.pyc
|   |-- 📄navs_section.cpython-311.pyc
|   |-- 📄nodes_section.cpython-311.pyc
|   |-- 📄page_section.cpython-311.pyc
|   |-- 📄root.cpython-311.pyc
|   |-- 📄routing.cpython-311.pyc
|   +-- 📄templating_section.cpython-311.pyc
|-- 📄a_quick_tour.py
|-- 📄dev_section.py
|-- 📄get_started_section.py
|-- 📄github_index.py
|-- 📄navs_section.py
|-- 📄nodes_section.py
|-- 📄page_section.py
|-- 📄root.py
|-- 📄routing.py
+-- 📄templating_section.py

```` 
manual/
|-- 📄__init__.py
|-- 📁__pycache__/
|   |-- 📄__init__.cpython-311.pyc
|   |-- 📄a_quick_tour.cpython-311.pyc
|   |-- 📄dev_section.cpython-311.pyc
|   |-- 📄get_started_section.cpython-311.pyc
|   |-- 📄navs_section.cpython-311.pyc
|   |-- 📄nodes_section.cpython-311.pyc
|   |-- 📄page_section.cpython-311.pyc
|   |-- 📄root.cpython-311.pyc
|   |-- 📄routing.cpython-311.pyc
|   +-- 📄templating_section.cpython-311.pyc
|-- 📄a_quick_tour.py
|-- 📄dev_section.py
|-- 📄get_started_section.py
|-- 📄github_index.py
|-- 📄navs_section.py
|-- 📄nodes_section.py
|-- 📄page_section.py
|-- 📄root.py
|-- 📄routing.py
+-- 📄templating_section.py
````

<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>manual/
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>|-- 📄__init__.py
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>|-- 📁__pycache__/
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>|   |-- 📄__init__.cpython-311.pyc
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>|   |-- 📄a_quick_tour.cpython-311.pyc
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>|   |-- 📄dev_section.cpython-311.pyc
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>|   |-- 📄get_started_section.cpython-311.pyc
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>|   |-- 📄navs_section.cpython-311.pyc
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>|   |-- 📄nodes_section.cpython-311.pyc
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>|   |-- 📄page_section.cpython-311.pyc
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>|   |-- 📄root.cpython-311.pyc
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>|   |-- 📄routing.cpython-311.pyc
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>|   +-- 📄templating_section.cpython-311.pyc
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>|-- 📄a_quick_tour.py
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>|-- 📄dev_section.py
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>|-- 📄get_started_section.py
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>|-- 📄github_index.py
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>|-- 📄navs_section.py
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>|-- 📄nodes_section.py
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>|-- 📄page_section.py
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>|-- 📄root.py
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>|-- 📄routing.py
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>+-- 📄templating_section.py
</span></code></pre></div>

Example: Style 'rounded'

Jinja

{{ "mknodes/manual" | MkTreeView(style="rounded") }}

Python

MkTreeView('mknodes/manual')

manual/
├── 📄__init__.py
├── 📁__pycache__/
│   ├── 📄__init__.cpython-311.pyc
│   ├── 📄a_quick_tour.cpython-311.pyc
│   ├── 📄dev_section.cpython-311.pyc
│   ├── 📄get_started_section.cpython-311.pyc
│   ├── 📄navs_section.cpython-311.pyc
│   ├── 📄nodes_section.cpython-311.pyc
│   ├── 📄page_section.cpython-311.pyc
│   ├── 📄root.cpython-311.pyc
│   ├── 📄routing.cpython-311.pyc
│   ╰── 📄templating_section.cpython-311.pyc
├── 📄a_quick_tour.py
├── 📄dev_section.py
├── 📄get_started_section.py
├── 📄github_index.py
├── 📄navs_section.py
├── 📄nodes_section.py
├── 📄page_section.py
├── 📄root.py
├── 📄routing.py
╰── 📄templating_section.py

```` 
manual/
├── 📄__init__.py
├── 📁__pycache__/
│   ├── 📄__init__.cpython-311.pyc
│   ├── 📄a_quick_tour.cpython-311.pyc
│   ├── 📄dev_section.cpython-311.pyc
│   ├── 📄get_started_section.cpython-311.pyc
│   ├── 📄navs_section.cpython-311.pyc
│   ├── 📄nodes_section.cpython-311.pyc
│   ├── 📄page_section.cpython-311.pyc
│   ├── 📄root.cpython-311.pyc
│   ├── 📄routing.cpython-311.pyc
│   ╰── 📄templating_section.cpython-311.pyc
├── 📄a_quick_tour.py
├── 📄dev_section.py
├── 📄get_started_section.py
├── 📄github_index.py
├── 📄navs_section.py
├── 📄nodes_section.py
├── 📄page_section.py
├── 📄root.py
├── 📄routing.py
╰── 📄templating_section.py
````

<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>manual/
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>├── 📄__init__.py
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>├── 📁__pycache__/
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>│   ├── 📄__init__.cpython-311.pyc
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>│   ├── 📄a_quick_tour.cpython-311.pyc
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>│   ├── 📄dev_section.cpython-311.pyc
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>│   ├── 📄get_started_section.cpython-311.pyc
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>│   ├── 📄navs_section.cpython-311.pyc
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>│   ├── 📄nodes_section.cpython-311.pyc
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>│   ├── 📄page_section.cpython-311.pyc
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>│   ├── 📄root.cpython-311.pyc
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>│   ├── 📄routing.cpython-311.pyc
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>│   ╰── 📄templating_section.cpython-311.pyc
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>├── 📄a_quick_tour.py
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>├── 📄dev_section.py
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>├── 📄get_started_section.py
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>├── 📄github_index.py
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>├── 📄navs_section.py
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>├── 📄nodes_section.py
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>├── 📄page_section.py
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>├── 📄root.py
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>├── 📄routing.py
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>╰── 📄templating_section.py
</span></code></pre></div>

Example: Style 'spaces'

Jinja

{{ "mknodes/manual" | MkTreeView(style="spaces") }}

Python

MkTreeView('mknodes/manual', style='spaces')

manual/
    📄__init__.py
    📁__pycache__/
        📄__init__.cpython-311.pyc
        📄a_quick_tour.cpython-311.pyc
        📄dev_section.cpython-311.pyc
        📄get_started_section.cpython-311.pyc
        📄navs_section.cpython-311.pyc
        📄nodes_section.cpython-311.pyc
        📄page_section.cpython-311.pyc
        📄root.cpython-311.pyc
        📄routing.cpython-311.pyc
        📄templating_section.cpython-311.pyc
    📄a_quick_tour.py
    📄dev_section.py
    📄get_started_section.py
    📄github_index.py
    📄navs_section.py
    📄nodes_section.py
    📄page_section.py
    📄root.py
    📄routing.py
    📄templating_section.py

```` 
manual/
    📄__init__.py
    📁__pycache__/
        📄__init__.cpython-311.pyc
        📄a_quick_tour.cpython-311.pyc
        📄dev_section.cpython-311.pyc
        📄get_started_section.cpython-311.pyc
        📄navs_section.cpython-311.pyc
        📄nodes_section.cpython-311.pyc
        📄page_section.cpython-311.pyc
        📄root.cpython-311.pyc
        📄routing.cpython-311.pyc
        📄templating_section.cpython-311.pyc
    📄a_quick_tour.py
    📄dev_section.py
    📄get_started_section.py
    📄github_index.py
    📄navs_section.py
    📄nodes_section.py
    📄page_section.py
    📄root.py
    📄routing.py
    📄templating_section.py
````

<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>manual/
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    📄__init__.py
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    📁__pycache__/
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>        📄__init__.cpython-311.pyc
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>        📄a_quick_tour.cpython-311.pyc
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>        📄dev_section.cpython-311.pyc
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>        📄get_started_section.cpython-311.pyc
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>        📄navs_section.cpython-311.pyc
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>        📄nodes_section.cpython-311.pyc
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>        📄page_section.cpython-311.pyc
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>        📄root.cpython-311.pyc
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>        📄routing.cpython-311.pyc
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a>        📄templating_section.cpython-311.pyc
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>    📄a_quick_tour.py
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>    📄dev_section.py
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a>    📄get_started_section.py
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>    📄github_index.py
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a>    📄navs_section.py
</span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>    📄nodes_section.py
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a>    📄page_section.py
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>    📄root.py
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a>    📄routing.py
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a>    📄templating_section.py
</span></code></pre></div>

Bases: MkCode

__init__ 

__init__(
    tree: str | os.PathLike | treelib.Node,
    *,
    style: treestyles.TreeStyleStr | tuple[str, str, str, str] = "rounded",
    maximum_depth: int | None = None,
    predicate: Callable | None = None,
    exclude_folders: list[str] | str | None = None,
    **kwargs: Any
)

Parameters:

Name Type Description Default
tree str | PathLike | Node

Tree to display. Can be a path to a folder or a Node.

 required
style TreeStyleStr | tuple[str, str, str, str]

Print style. If tuple, parts are used for stems

 'rounded'
maximum_depth int | None

Maximum nesting depth to print

 None
predicate Callable | None

Predicate to filter results

 None
exclude_folders list[str] | str | None

Folders to exclude from listing

 None
kwargs Any

Keyword arguments passed to parent

 {}
Name Children Inherits
MkCode
mknodes.basenodes.mkcode
Class representing a Code block.		 
graph TD
  94854583229712["mktreeview.MkTreeView"]
  94854582908560["mkcode.MkCode"]
  94854582919984["mkcontainer.MkContainer"]
  94854582916880["mknode.MkNode"]
  94854582838576["node.Node"]
  140544995341632["builtins.object"]
  94854582908560 --> 94854583229712
  94854582919984 --> 94854582908560
  94854582916880 --> 94854582919984
  94854582838576 --> 94854582916880
  140544995341632 --> 94854582838576
/home/runner/work/mknodes/mknodes/mknodes/templatenodes/mktreeview/metadata.toml
[metadata]
icon = "mdi:file-tree-outline"
name = "MkTreeView"

[examples.regular]
title = "Different styles"
jinja = """
{{ "mknodes/manual" | MkTreeView }}
"""

[examples.ansi]
title = "Style 'ansi'"
jinja = """
{{ "mknodes/manual" | MkTreeView(style="ansi") }}
"""

[examples.ascii]
title = "Style 'ascii'"
jinja = """
{{ "mknodes/manual" | MkTreeView(style="ascii") }}
"""

[examples.rounded]
title = "Style 'rounded'"
jinja = """
{{ "mknodes/manual" | MkTreeView(style="rounded") }}
"""

[examples.spaces]
title = "Style 'spaces'"
jinja = """
{{ "mknodes/manual" | MkTreeView(style="spaces") }}
"""

# [examples.remote]
# title = "Files from a repote path"
# jinja = """
# {{ "github://" | MkTreeView(storage_options={"org": "mkdocstrings", "repo": "mkocstrings"}, maximum_depth=2) }}
# """

[output.markdown]
template = """
{{ node.fence_boundary }} 
{{ node.tree.get_tree_repr(style=node.style, max_depth=node.maximum_depth) }}
{{ node.fence_boundary }}
"""
mknodes.templatenodes.mktreeview.MkTreeView
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class MkTreeView(mkcode.MkCode):
    """Node to display tree structures.

    Currently supports directories and Node subclasses (including `MkNodes`).
    """

    ICON = "material/file-tree-outline"
    STATUS = "new"

    def __init__(
        self,
        tree: str | os.PathLike | treelib.Node,
        *,
        style: treestyles.TreeStyleStr | tuple[str, str, str, str] = "rounded",
        maximum_depth: int | None = None,
        predicate: Callable | None = None,
        exclude_folders: list[str] | str | None = None,
        **kwargs: Any,
    ):
        """Constructor.

        Arguments:
            tree: Tree to display. Can be a path to a folder or a Node.
            style: Print style. If tuple, parts are used for stems
            maximum_depth: Maximum nesting depth to print
            predicate: Predicate to filter results
            exclude_folders: Folders to exclude from listing
            kwargs: Keyword arguments passed to parent
        """
        super().__init__(language="", **kwargs)
        self._tree = tree
        self.style = style
        self.predicate = predicate
        self.maximum_depth = maximum_depth
        self.exclude_folders = (
            [exclude_folders] if isinstance(exclude_folders, str) else exclude_folders
        )

    @property
    def tree(self) -> treelib.Node:
        match self._tree:
            case str() | os.PathLike():
                return treelib.FileTreeNode.from_folder(
                    upath.UPath(self._tree),
                    predicate=self.predicate,
                    exclude_folders=self.exclude_folders,
                    maximum_depth=self.maximum_depth,
                )
            case mknode.MkNode():
                return self._tree
            case _:
                raise TypeError(self._tree)

    @property
    def text(self):
        return self.tree.get_tree_repr(style=self.style, max_depth=self.maximum_depth)